home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / libs / progargslib.lha / ProgArgs / readme.txt < prev    next >
Text File  |  1995-04-08  |  5KB  |  113 lines
  1. Program Arguments Library v1
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~
  3. Copyright (C)1995 by Dianne Hackborn.
  4.  
  5. =========================================================================
  6. This library is shareware.  If you like it and use it in your
  7. programs, please consider becoming a registered developer by sending 
  8. $5 US to me.  [My address is below.]  This will allow me to provide
  9. answers to questions you may have about its use and the resources to
  10. continue to develop the library.  There is no fee for users.
  11.  
  12. This library is freely distributable as long as all of its files are
  13. included with no modifications.  By becoming registered, you will be
  14. allowed to include a subset of the library distribution with your program
  15. if you so desire.  The library is provided as-is, with no warranties of
  16. any kind.
  17.  
  18. People interested in using this in a commercial product should
  19. contact me to discuss it.  [I'm not greedy.  Really. ;)]
  20. =========================================================================
  21. Installer and Installer project icon
  22. (c) Copyright 1991-93 Commodore-Amiga, Inc.  All Rights Reserved.
  23. Reproduced and distributed under license from Commodore.
  24.  
  25. INSTALLER SOFTWARE IS PROVIDED "AS-IS" AND SUBJECT TO CHANGE;
  26. NO WARRANTIES ARE MADE.  ALL USE IS AT YOUR OWN RISK.  NO LIABILITY
  27. OR RESPONSIBILITY IS ASSUMED.    
  28. =========================================================================
  29.  
  30. INTRODUCTION
  31.  
  32.     ProgArgs is a shared library which is intended to make the handling
  33.     of CLI, Workbench and text file arguments simpler and more consistent.
  34.     It basically provides a wrapper around the DOS ReadArgs() function and
  35.     the Workbench argument functions, which unifies them into one standard
  36.     interface.  It also provides support for intelligently writing tool
  37.     types back out to disk -- only modifying the relevant entries, creating
  38.     comments for tool types which do not have a value, etc -- and provides
  39.     for the reading and writing of text files which are formatted much like
  40.     tool types.
  41.     
  42.     While there are a number of things that the library currently does not
  43.     support [the most notable probably being the inability to dynamically
  44.     add and remove argument definitions], I believe that the library as-is
  45.     provides enough functionality that it may be useful to others.  The
  46.     addition of new features will depend on how much I need them and the
  47.     response to the library from others.
  48.     
  49. INSTALLATION
  50.  
  51.     Included with the library is an installation tool; just double-click on
  52.     the 'Install' icon to start up the standard Amiga Installer program.
  53.     This will install the library, locale catalogs, compiler header files,
  54.     support libraries, and documentation.  You should almost definitely
  55.     choose a level of at least 'intermediate,' as the program is not
  56.     intelligent enough to figure out good places to put the developer files
  57.     when doing a novice installation; you will probably have to direct it
  58.     to the appropriate places yourself.
  59.  
  60. THE EXAMPLE PROGRAMS
  61.  
  62.     Included with this archive is an example program, Example1,
  63.     showing how to use the library.  This is a fairly simple program
  64.     which shows a couple of ways to handle program arguments.  Note that
  65.     you shouldn't need to install the library to try the example; it will
  66.     be able to find it if you execute it from its original location in
  67.     the distribution.
  68.     
  69.     If you own SAS/C v6.0 or later, you should be able to compile the
  70.     example program by simply double clicking on the build icon in the
  71.     Examples directory.  Note that you will need the progargs.library
  72.     include files in the compiler's search path in order to get it to
  73.     compile.
  74.  
  75. WHERE TO GO NOW
  76.  
  77.     The two main sources of documentation are the autodocs and the
  78.     header file.  If you have AmigaGuide, read the file "ProgArgs.guide"
  79.     in the includes directory.  This is the fully linked AmigaGuide
  80.     version of the autodocs, with appropriate connections to the
  81.     header file [and the system header files, too, if you have them in
  82.     your AmigaGuide search path].
  83.     
  84.     Otherwise, the autodocs are suppled as a plain text file in
  85.     "ProgArgs.doc".
  86.     
  87.     The first entries you will probably want to read are AllocProgArgsA(),
  88.     ExecProgArgsA(), and AllocTagArgsA(), then just follow their links.
  89.     
  90. WHAT ISN'T HERE
  91.  
  92.     The library documentation should be fairly complete; as mentioned above,
  93.     there are a number of features which would be nice to have, and I expect
  94.     to get around to implementing them sooner or later.  Please let me know
  95.     of anything you would like to see.
  96.     
  97. HOW TO REACH ME
  98.  
  99.     EMail -     SCHOOL: hackbod@mail.cs.orst.edu (prefered)
  100.                 BIX: dhack@bix.com (unlikely that I'll see anything sent here)
  101.  
  102.     SnailMail - Dianne Hackborn
  103.                 2895 Los Altos Drive
  104.                 Meridian, ID 83642
  105.     
  106.     SWIFT Deposit Number: 1 23000 123
  107.     First Interstate Bank of Oregon, N.A.
  108.             
  109. FINALLY
  110.  
  111.     Have fun, and I hope you find the library useful.  All comments,
  112.     suggestions and bug reports are more than welcome.
  113.